Use a PageHost node to group Page and PageHost nodes, and to manage navigation requests and transitions in a tree of Page nodes under a PageHost node. More...

#include <kanzi/ui/node/page_host.hpp>

Inheritance diagram for kanzi::PageHost:

Classes
class	NavigateNextMessageArguments
	Represents message arguments of NavigateNext message. More...

class	NavigatePreviousMessageArguments
	Represents message arguments of NavigatePrevious message. More...

class	NavigationFinishedMessageArguments
	Represents message arguments of NavigationFinished message. More...

class	NavigationStartedMessageArguments
	Represents message arguments of NavigationStarted message. More...

Public Member Functions
PageSharedPtr	getDefaultChild () const
	PageHost nodes keep track of their default or the currently active subpage. More...

void	setDefaultChild (PageSharedPtr page)
	Sets the default or the currently active subpage. More...

bool	navigateTo (Page &page, bool immediate)
	Requests to navigate to the given Page node. More...

bool	isTransitionInProgress () const
	Checks whether there is an ongoing transition between Page nodes. More...

PageTransitionCollectionSharedPtr	getTransitionCollection () const
	Retrieves transitions used in the scope of this PageHost node. More...

void	setTransitionCollection (PageTransitionCollectionSharedPtr transitions)
	Set transitions to be used by this PageHost node. More...

Public Member Functions inherited from kanzi::Page
Page *	getParentPage () const
	Returns the parent Page or PageHost node in the scene graph. More...

bool	isTreeRoot () const
	Checks whether a Page node is a root of all the pages in the tree. More...

vector< PageSharedPtr >	findSubpages () const
	Returns all immediate subpages in the scene graph. More...

void	navigate (bool immediate=false)
	Requests navigation to this Page or PageHost node by sending a message to the scene graph. More...

bool	isState () const
	Gets the value of StateProperty. More...

void	setState (bool value)
	Sets the value of StateProperty. More...

float	getTransitionPhase () const
	Gets the value of TransitionPhaseProperty. More...

void	setTransitionPhase (float value)
	Sets the value of TransitionPhaseProperty. More...

bool	isAutoActivate () const
	Gets the value of AutoActivateProperty. More...

void	setAutoActivate (bool value)
	Sets the value of AutoActivateProperty. More...

Vector2	getSlideOffset () const
	Gets the value of SlideOffsetProperty. More...

void	setSlideOffset (Vector2 value)
	Sets the value of SlideOffsetProperty. More...

Vector2	getScaleOffset () const
	Gets the value of ScaleOffsetProperty. More...

void	setScaleOffset (Vector2 value)
	Sets the value of ScaleOffsetProperty. More...

float	getRotationOffset () const
	Gets the value of RotationOffsetProperty. More...

void	setRotationOffset (float value)
	Sets the value of RotationOffsetProperty. More...

Public Member Functions inherited from kanzi::Node2D
virtual	~Node2D ()

ChildConstIterator	beginChildren () const

ChildConstIterator	endChildren () const

ChildConstReverseIterator	rbeginChildren () const

ChildConstReverseIterator	rendChildren () const

void	addChild (Node2DSharedPtr child)
	Adds a child node. More...

void	insertChild (size_t index, Node2DSharedPtr child)
	Adds a child node for object node to given index. More...

void	removeChild (const Node &child)
	Removes child node. More...

void	removeChild (size_t index)
	Removes child node at specified index. More...

void	removeAllChildren ()
	Removes all child nodes. More...

Node2DSharedPtr	getChild (size_t index) const
	Returns a child from given index from object node. More...

size_t	getChildIndex (const Node &child) const
	Returns the index of a child in an object node. More...

bool	hasChild (const Node &child) const
	Returns whether or not the child exists. More...

size_t	getChildCount () const
	Gets the number of children of the node. More...

void	moveToBack ()
	Repositions the node to the beginning of its parent's children, so that it is drawn first. More...

void	moveToFront ()
	Repositions the node to the end of its parent's children, so that it is drawn last. More...

RenderType	getRenderType () const
	Get render type. More...

BrushSharedPtr	getBackgroundBrush () const
	Gets value of BackgroundBrushProperty. More...

void	setBackgroundBrush (BrushSharedPtr value)
	Sets value of BackgroundBrushProperty. More...

BrushSharedPtr	getCompositionBrush () const
	Gets value of CompositionBrushProperty. More...

void	setCompositionBrush (BrushSharedPtr value)
	Sets value of CompositionBrushProperty. More...

BrushSharedPtr	getForegroundBrush () const
	Gets value of ForegroundBrushProperty. More...

void	setForegroundBrush (BrushSharedPtr value)
	Sets value of ForegroundBrushProperty. More...

BrushRenderer *	getBackgroundBrushRenderer () const
	Get background brush renderer. More...

BrushRenderer *	getForegroundBrushRenderer () const
	Get foreground brush renderer. More...

BrushRenderer *	getCacheChildrenBrushRenderer () const
	Access cache children brush renderer. More...

BrushRenderer *	getCacheSelfBrushRenderer () const
	Access cache self brush renderer. More...

BrushRenderer *	getCompositionBrushRenderer () const
	Access cache result brush renderer. More...

SRTValue2D	getRenderTransformation () const
	Gets the value of RenderTransformationProperty. More...

void	setRenderTransformation (SRTValue2D value)
	Sets the value of RenderTransformationProperty. More...

SRTValue3D	getPerspectiveTransformation () const
	Gets the value of PerspectiveTransformationProperty. More...

void	setPerspectiveTransformation (SRTValue3D value)
	Sets the value of PerspectiveTransformationProperty. More...

void	render (Renderer3D &renderer, CompositionStack &compositionStack)
	Render individual 2D node. More...

NodeVisual2D *	getVisual () const
	Access visual component. More...

TextureSharedPtr	getRenderTarget () const
	Gets value of RenderTargetProperty. More...

void	setRenderTarget (TextureSharedPtr texture)
	Sets value of RenderTargetProperty. More...

TextureSharedPtr	getFinalCompositionTarget () const
	Returns composition target combining all Node2D content. More...

bool	hasCacheChildren () const
	Tell if node should cache its children. More...

bool	hasCacheChildrenCompositionTarget () const
	Tell if node has cache children composition target. More...

bool	isCacheChildrenValid () const
	Tell if children cache is valid. More...

void	resetCacheChildren ()
	Reset cached content for children. More...

bool	hasCacheResult () const
	Tell if node should cache its result. More...

bool	hasFinalCompositionTarget () const
	Tell if node has final composition target. More...

bool	isCacheResultValid () const
	Tell if children cache is valid. More...

void	resetCacheResult ()
	Reset cached content for complete node content including itself and its children. More...

bool	hasCacheSelf () const
	Tell if node should cache itself. More...

bool	hasCacheSelfCompositionTarget () const
	Tell if node has cache children composition target. More...

bool	isCacheSelfValid () const
	Tell if children cache is valid. More...

void	resetCacheSelf ()
	Reset cached content for node itself. More...

CompositionManager *	getCompositionManager () const
	Access composition manager. More...

NodeCompositor2D *	getCompositor () const
	Access compositor component. More...

void	setAutoWidth ()
	Sets node to automatically determine width. More...

void	setAutoHeight ()
	Sets node to automatically determine height. More...

void	setAutoSize ()
	Sets node to automatically determine both width and height. More...

void	setSize (float width, float height)
	Sets size properties of the node. More...

void	setLayoutSize (float width, float height)
	Sets size properties of the node. More...

SRTValue2D	getLayoutTransformation () const
	Gets the value of LayoutTransformationProperty. More...

void	setLayoutTransformation (SRTValue2D value)
	Sets the value of LayoutTransformationProperty. More...

Vector2	getDesiredSize () const
	Get desired size. More...

void	setDesiredSize (Vector2 size)
	Set desired size. More...

Vector2	getAllocatedSize () const
	Get allocated size. More...

void	setAllocatedSize (Vector2 allocatedSize)
	Set allocated size. More...

Vector2	getActualSize () const
	Get actual size. More...

void	setActualSize (Vector2 actualSize)
	Set actual size. More...

void	setActualSize (float sizeX, float sizeY)
	Set actual size. More...

Matrix3x3	getArrangeTransform () const
	Get arrange transform. More...

void	setArrangeTransform (Matrix3x3 transform)
	Set arrange transform. More...

void	layout (optional< Matrix3x3 > rootTransform)
	Does layout pass starting from this node and iterating recursively all of its children. More...

void	layout ()
	Does layout pass with no root transformation (identity). More...

bool	measure (const Vector2 *availableSize, bool handleStretch)
	Measure one node. More...

virtual bool	measureRecursive ()
	Perform measure recursively. More...

void	arrange ()
	Arrange one Node2D. More...

void	extract ()
	Extract one Node2D. More...

Matrix3x3	getWorldTransform () const
	Get world transform. More...

bool	containsLocal (Vector2 point) const
	Tell if a node area contains a point (defined in node's own space). More...

optional< Vector2 >	containsGlobal (Vector2 point) const
	Tell if a node area contains a point (defined in screen space). More...

optional< Vector2 >	globalToLocal (Vector2 point) const

NodeSharedPtr	hitTest (Vector2 point)
	Performs a hit test to a 2D node and all its child nodes. More...

NodeSharedPtr	hitTest (Vector2 point, const Metaclass *type)
	Performs a hit test to a 2D node and all its child nodes. More...

NodeSharedPtr	hitTestIterate (Vector2 point, HitTestVisitor visitor, void *userData)
	Recursively hit test nodes from this node downwards and call visitor function on nodes hit. More...

virtual tuple< NodeSharedPtr, KzcRay, float >	hitTestContent (Vector2 point)
	Default implementation of Node2D content hit test. More...

template<typename T >
shared_ptr< T >	hitTest (Vector2 point)
	Wrapper for hitTest(Vector2), casts the return value. More...

template<typename T >
shared_ptr< T >	hitTest (Vector2 point, const Metaclass *type)
	Wrapper for hitTest(Vector2, const Metaclass), casts the return value. More...

virtual NodeSharedPtr	findAbstractChildOverride (string_view name) KZ_OVERRIDE
	Node::findAbstractChildOverride() implementation. More...

virtual VisitorResult	visitAbstractChildOverride (const Visitor &visitor, VisitorOrder order) KZ_OVERRIDE
	Node::visitAabstractChild implementation. More...

virtual bool	addAbstractChildOverride (NodeSharedPtr child) KZ_OVERRIDE
	Node::addAbstractChildOverride() implementation. More...

virtual size_t	getAbstractChildCountOverride () KZ_OVERRIDE
	Node::getAbstractChildCountOverride() implementation. More...

virtual NodeSharedPtr	getAbstractChildOverride (size_t index) KZ_OVERRIDE
	Node::getAbstractChildOverride() implementation. More...

virtual bool	removeAbstractChildOverride (Node &child) KZ_OVERRIDE
	Node::removeAbstractChildOverride() implementation. More...

bool	compositionRequiresAlpha () const
	Tell if composition requires alpha. More...

void	setCompositionRequiresAlpha (bool enabled)
	Turn composition alpha requirement on or off. More...

bool	compositionRequiresDepth () const
	Tell if composition requires depth. More...

void	setCompositionRequiresDepth (bool enabled)
	Turn composition depth requirement on or off. More...

bool	compositionRequiresStencil () const
	Tell if composition requires stencil. More...

void	setCompositionRequiresStencil (bool enabled)
	Turn composition stencil requirement on or off. More...

QuadDescription	getBackgroundQuad () const
	Gets the background quad description. More...

ClippingArea	getClippingArea () const
	Get clipping area. More...

float	getLayoutOpacity () const
	Get opacity after propagation from layouting hierarchy. More...

Matrix3x3	getRenderQuadTransform () const
	Gets transformation used to render the 2D node. More...

bool	hasCenterClipArea () const
	Tell if Node2D has the center clip area (the area of itself). More...

bool	hasOutsideClipArea () const
	Tell if Node2D has outside clipping area. More...

bool	hasTranslucentForeground () const
	Tell if Node2D foreground has translucency. More...

void	setForegroundIsTranslucent (bool enabled)
	Set foreground translucency status. More...

void	setFinalCompositionRequested (bool enabled)
	Turn composition request on or off. More...

bool	isCompositionClearColorRequired () const
	Indicates whether composition target requires color clear before rendering. More...

bool	isClearColorAllowed () const
	Indicates whether this Node2D is allowed and should clear the color buffer of its own composition target. More...

void	setClearColorAllowed (bool enabled)
	Set clear color allowed. More...

bool	isRenderChildrenAllowed () const
	Tell if rendering children is allowed. More...

bool	isRenderSelfAllowed () const
	Tell if render self is allowed. More...

bool	isVisibleForHitTesting () const
	Tell if Node2D is visible for hit testing. More...

bool	requiresBackgroundBrushRendering () const
	Tell if background brush rendering is required. More...

bool	requiresForegroundBrushRendering () const
	Tell if foreground brush rendering is required. More...

bool	hasChildrenRequireExtract () const
	Tell if children require extract flag is on. More...

void	setChildrenRequireExtract (bool enabled)
	Set children require extract flag. More...

bool	requiresExtract () const
	Tell if node requires extraction. More...

void	setRequiresExtract (bool enabled)
	Turn extract requirement on or off. More...

bool	isSelfInCompositionTarget () const
	Tell if node itself is going to get rendered into a composition target. More...

Vector2	getContentDesiredSize () const
	Get size desired by content. More...

Vector2	getSecondPassDesiredSize () const
	Get second pass desired size. More...

Vector2	getUserDesiredSize () const
	Get size desired by user. More...

Matrix3x3	getPartialArrangeTransform () const
	Get partial arrange transform. More...

float	getAspectRatio () const
	Gets the value of AspectRatioProperty. More...

void	setAspectRatio (float value)
	Sets the value of AspectRatioProperty. More...

bool	isForceComposition () const
	Gets the value of ForceCompositionProperty. More...

void	setForceComposition (bool value)
	Sets the value of ForceCompositionProperty. More...

Node2D::ForegroundHint	getForegroundHint () const
	Gets the value of ForegroundHintProperty. More...

void	setForegroundHint (Node2D::ForegroundHint value)
	Sets the value of ForegroundHintProperty. More...

bool	isCacheChildren () const
	Gets the value of CacheChildrenProperty. More...

void	setCacheChildren (bool value)
	Sets the value of CacheChildrenProperty. More...

bool	isCacheResult () const
	Gets the value of CacheResultProperty. More...

void	setCacheResult (bool value)
	Sets the value of CacheResultProperty. More...

bool	isCacheSelf () const
	Gets the value of CacheSelfProperty. More...

void	setCacheSelf (bool value)
	Sets the value of CacheSelfProperty. More...

bool	isOffscreenRendering () const
	Gets the value of OffscreenRenderingProperty. More...

void	setOffscreenRendering (bool value)
	Sets the value of OffscreenRenderingProperty. More...

bool	isDisableRenderTargetClear () const
	Gets the value of DisableRenderTargetClearProperty. More...

void	setDisableRenderTargetClear (bool value)
	Sets the value of DisableRenderTargetClearProperty. More...

Node2D::PixelFormat	getPixelFormat () const
	Gets the value of PixelFormatProperty. More...

void	setPixelFormat (Node2D::PixelFormat value)
	Sets the value of PixelFormatProperty. More...

bool	isRenderSelf () const
	Gets the value of RenderSelfProperty. More...

void	setRenderSelf (bool value)
	Sets the value of RenderSelfProperty. More...

float	getRenderTargetMinimumHeight () const
	Gets the value of RenderTargetMinimumHeightProperty. More...

void	setRenderTargetMinimumHeight (float value)
	Sets the value of RenderTargetMinimumHeightProperty. More...

float	getRenderTargetMinimumWidth () const
	Gets the value of RenderTargetMinimumWidthProperty. More...

void	setRenderTargetMinimumWidth (float value)
	Sets the value of RenderTargetMinimumWidthProperty. More...

float	getRenderTargetReallocationLimit () const
	Gets the value of RenderTargetReallocationLimitProperty. More...

void	setRenderTargetReallocationLimit (float value)
	Sets the value of RenderTargetReallocationLimitProperty. More...

Vector2	getRenderTransformationOrigin () const
	Gets the value of RenderTransformationOriginProperty. More...

void	setRenderTransformationOrigin (Vector2 value)
	Sets the value of RenderTransformationOriginProperty. More...

bool	isSnapToPixel () const
	Gets the value of SnapToPixelProperty. More...

void	setSnapToPixel (bool value)
	Sets the value of SnapToPixelProperty. More...

Public Member Functions inherited from kanzi::Node
virtual	~Node ()
	Destructor. More...

template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getProperty (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property. More...

AbstractPropertyTypeDescriptor::ValueSource *	getNodeFinalValueSource (AbstractPropertyTypeDescriptor &descriptor) const

template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType >	getOptionalProperty (const PropertyType< DataType > &propertyType) const
	Evaluates the property value in the same way as the overload above but does not default to the value in property metadata if there are no inputs to the property value. More...

template<typename DataType >
DataType	getAbstractProperty (AbstractPropertyType abstractPropertyType) const

template<typename DataType >
optional< typename PropertyType< DataType >::DataType >	getOptionalAbstractProperty (AbstractPropertyType abstractPropertyType) const

template<typename TMessageType , typename TClass , typename TClassMethod >
MessageSubscriptionToken	addMessageHandler (TMessageType &messageType, TClass *messageHandlerObject, TClassMethod method)
	Adds a message handler where handler is a method to invoke on an object. More...

template<typename TMessageType , typename TClass , typename TClassMethod >
MessageSubscriptionToken	addMessageFilter (TMessageType &messageType, TClass *messageHandlerObject, TClassMethod method)
	Adds a message filter where filter is a method to invoke on an object. More...

template<typename TMessageType >
MessageSubscriptionToken	addMessageHandler (const TMessageType &messageType, typename TMessageType::FunctionType function)
	Adds a message handler where handler is function. More...

template<typename TMessageType >
MessageSubscriptionToken	addMessageFilter (const TMessageType &messageType, typename TMessageType::FunctionType function)
	Adds a message filter where filter is function. More...

template<typename TMessageType >
MessageSubscriptionToken	addMessageHandler (const TMessageType &messageType, typename TMessageType::FunctionType function, Node *messageSourceFilter)
	Adds a message handler where handler is function and accepted source is explicitly defined. More...

void	removeMessageHandler (MessageSubscriptionToken token)
	Removes a message subscription. More...

template<typename TArgumentsType >
void	dispatchMessage (const MessageType< TArgumentsType > &messageType, typename MessageType< TArgumentsType >::ArgumentsType &messageArguments)
	Dispatches a message with specified arguments. More...

void	addResource (const ResourceID &resourceId, string_view resourceUrl)
	Adds a resource manager resource to an object node. If resourceID already exists in object, removes the existing entry. If resourceURL is NULL, error is thrown. */. More...

void	removeResource (const ResourceID &resourceId)
	Removes a resource with given ID from object node resource dictionary. Does not do anything if resourceID was not found. */. More...

bool	containsResource (const ResourceID &resourceID) const
	Returns if object node resource dictionary contains the resource with given ID. Resource can be any type: style, alias or resource manager resource. */. More...

optional< string >	findResourceURL (const ResourceID &resourceId) const
	Tries to find Resource URL for Resource ID from this node. More...

ResourceSharedPtr	acquireResource (const ResourceID &id) const
	Acquires a resource from the node or the node's closest ancestor having the resource id in the resource dictionary. More...

template<typename T >
shared_ptr< T >	acquireResource (const ResourceID &id) const
	Acquires a resource from the node or the node's closest ancestor having the resource id in the resource dictionary, and casts the resource to given type. More...

ResourceSharedPtr	tryAcquireResource (const ResourceID &id) const
	Acquires a resource from the node or the node's closest ancestor having the resource id in the resource dictionary. More...

ResourceManager::AcquireTaskSharedPtr	acquireResourceAsync (const ResourceID &key, ResourceManager::AsyncAcquireFinishedCallback func) const
	Posts an asynchronous task to acquire a resource. More...

template<typename T >
shared_ptr< T >	tryAcquireResource (const ResourceID &id) const
	Acquires a resource from the node or the node's closest ancestor having the resource and casts the resource to given type. More...

ResourceDictionarySharedPtr	getResourceDictionary () const
	Gets the resource dictionary of the node, if the node has one. More...

ResourceDictionarySharedPtr	acquireResourceDictionary ()
	Gets the resource dictionary of the node. More...

void	notifyResourceDictionaryModified ()
	Forces the re-evaluation of resource IDs in a node tree. More...

void	setResourceDictionary (ResourceDictionarySharedPtr resourceDictionary)
	Replaces the resource dictionary of the node. More...

void	addResourceDictionary (ResourceDictionarySharedPtr resourceDictionary)
	Add a nested resource dictionary to the resource dictionary of the node. More...

void	addAnonymousResource (ResourceSharedPtr resource)
	Adds alias resource to an object node. More...

void	removeAnonymousResource (const Resource &resource)
	Removes anonymous resource from object node resources. More...

bool	isNamed (string_view name) const

Node *	getParent () const
	Returns the parent of the node. More...

void	setParent (Node *parent)

VisitorResult	visit (const Visitor &visitor, VisitorOrder order)

VisitorResult	visitDescendants (const Visitor &visitor, VisitorOrder order)

template<typename Type >
shared_ptr< Type >	lookupNode (string_view pathOrKey)
	Returns a node of specified type by looking it up with specified path or alias. More...

Node *	lookupNodeRaw (string_view relativePath)
	Get an object node by another node and a relative path. More...

ObjectSharedPtr	lookupObject (string_view relativePath)
	Lookup for an object from a node. More...

tuple< NodeSharedPtr, AbstractPropertyType >	lookupObjectForStateManager (string_view relativePath)
	Lookup for an node and possible object from within the node for state manager. More...

template<typename Type >
shared_ptr< Type >	lookupObject (string_view path)
	Lookup for an object from a node. More...

template<typename TNodeType >
shared_ptr< TNodeType >	findAbstractChild (string_view name)
	Find a child by name. Finds direct children as well as children connected indirectly for example Viewport->Scene. More...

void	addInputManipulator (InputManipulatorSharedPtr inputManipulator)
	Transfers the ownership and attaches an input manipulator to an object node. More...

void	removeInputManipulator (InputManipulator &inputManipulator)
	Removes the ownership and detaches an input manipulator from an object node. More...

InputManipulatorConstIterator	beginInputManipulators () const

InputManipulatorConstIterator	endInputManipulators () const

void	addBinding (BindingSharedPtr binding)
	Transfers the ownership of a binding rule to an object node. More...

void	addBindingWithOwner (BindingSharedPtr binding, shared_ptr< void > owner)
	Transfers the ownership of a binding rule to an object node and sets the owner of binding rule. More...

void	removeBinding (Binding &binding)
	Removes the ownership and detaches a binding rule from an object node. More...

void	removeBindingsWithOwner (shared_ptr< void > owner)
	Removes all bindings with the specified owner. More...

BindingConstIterator	beginBindings () const

BindingConstIterator	endBindings () const

void	addNodeComponent (NodeComponentSharedPtr nodeComponent)
	Transfers the ownership of a node component to an object node. More...

void	addNodeComponentWithOwner (NodeComponentSharedPtr nodeComponent, const void *owner)
	Transfers the ownership of a node component to an object node and sets the owner of the node component. More...

void	removeNodeComponent (NodeComponent &nodeComponent)
	Removes the ownership of a node component from an object node. More...

void	removeNodeComponentWithOwner (const void *owner)
	Removes all bindings with the specified owner. More...

NodeComponentConstIterator	beginNodeComponents () const

NodeComponentConstIterator	endNodeComponents () const

template<typename Type >
shared_ptr< Type >	lookupNodeComponent (string_view name)
	Returns a node component of specified type by looking it up with specified name. More...

void	setRenderable (bool state)
	Sets whether the object node is renderable. More...

bool	isRenderable () const
	Returns whether node is renderable. More...

bool	isEffectivelyVisible () const
	Checks if the node and all of its ancestors are visible. More...

bool	isEffectivelyEnabled () const
	Checks if the node and all of its ancestors are enabled. More...

uint32_t	getChangeFlags () const
	Get current change flags. More...

uint32_t	getChildChangeFlags () const
	Get current child change flags. More...

void	setChangeFlag (uint32_t flag)
	Sets a change flag. More...

void	clearChangeFlag (uint32_t flag)
	Clears a change flag. More...

bool	isChangeFlagSet (uint32_t flag) const
	Checks if a change flag is set. More...

bool	isAnyChangeFlagSet (uint32_t flag) const
	Checks if any of given flags is set. More...

void	setChildChangeFlag (uint32_t flag)
	Sets a child change flag. More...

void	clearChildChangeFlag (uint32_t flag)
	Clears a child change flag. More...

bool	isChildChangeFlagSet (uint32_t flag) const
	Checks if child change flags match. More...

bool	isAnyChildChangeFlagSet (uint32_t flag) const
	Checks if any child change flags (corresponding to given mask) are set. More...

bool	isInvalidMeasure () const
	Check if the node needs measure. More...

void	invalidateMeasure ()
	Invalidates measure for the node. More...

void	validateMeasure ()
	Validates measure for the node. More...

bool	isInvalidArrange () const
	Checks if the node needs arrange. More...

void	invalidateArrange ()
	Invalidates arrange. More...

void	validateArrange ()
	Validates arrange. More...

bool	isInvalidRender () const
	Returns if node render flag is invalid. More...

void	validateRender ()
	Validates render for node. More...

void	invalidateRender ()
	Invalidates render for node. More...

bool	isInvalidFinalTransform () const
	Tells if final transform flag is invalid for node. More...

void	invalidateFinalTransform ()
	Invalidates final transform for node. More...

bool	isInvalidDraw ()
	Tells if node draw flag is invalid. More...

void	invalidateDraw ()
	Invalidates draw flag for the node. More...

void	validateDraw ()
	Validates draw flags for the node. More...

void	validateDrawForChildrenRecursive ()
	Recursively validates draw for the children from this 2D node onwards. More...

bool	isInitialized () const
	Returns true if initialize() has been called, false otherwise. More...

bool	isAttached () const
	Returns true if the node is attached to a screen or one of its descendants. More...

bool	isAttaching () const
	Returns true if node is in the process of attaching, false otherwise. More...

bool	isDetaching () const
	Returns true if the node currently detaching. More...

void	attachRecursive ()
	Attaches an object node and its children recursively. More...

void	detachRecursive ()
	Detaches an object node and its children recursively. More...

virtual const KzuBoundingVolume *	getBoundingVolume () const
	Gets bounding volume from object node. More...

AppliedStyleEntrySharedPtr	applyStyle (StyleSharedPtr style)
	Applies a style to an object node. More...

AppliedStyleEntrySharedPtr	applyManualStyle (StyleSharedPtr style)
	Applies a style to an object node. More...

void	unapplyStyle (AppliedStyleEntrySharedPtr appliedStyleEntry)
	Unapplies a style from an object node. More...

void	applyStyles ()
	Apply all styles for an object node. More...

void	unapplyStyles ()
	Unapplies and removes all applied styles. More...

void	applyStylesRecursive ()
	Applies styles recursively. More...

void	unapplyStylesRecursive ()
	Unapplies styles recursively. More...

void	removeKZBData ()
	Destroys all object node data loaded from KZB, including properties, bindings, node comopnents, resources etc. More...

void	addResourceReference (AbstractPropertyType propertyType, AbstractResourceReference *reference)
	This is a helper for automatic resource tracking in ResourceReference. More...

void	removeResourceReference (const AbstractResourceReference &reference)
	This is a helper for automatic resource tracking in ResourceReference. More...

void	addNodeReference (AbstractPropertyType propertyType, AbstractNodeReference *reference)

void	removeNodeReference (const AbstractNodeReference &reference)

ScriptingContextSharedPtr	getScriptingContext () const

void	setScriptingContext (ScriptingContextSharedPtr context)

void	setTemplateRoot (NodeSharedPtr templateRoot)
	Sets the template root of this node. More...

NodeSharedPtr	getTemplateRoot () const
	Gets the template root of this node. More...

bool	trySetActiveFocus ()
	The method tries to move the active focus on this node. More...

string	getName () const
	Gets the value of NameProperty. More...

void	setName (string_view value)
	Sets the value of NameProperty. More...

string	getPath () const
	Gets the value of PathProperty. More...

void	setPath (string value)
	Sets the value of PathProperty. More...

string	getLocale () const
	Gets the value of LocaleProperty. More...

void	setLocale (string value)
	Sets the value of LocaleProperty. More...

bool	isHitTestable () const
	Gets the value of HitTestableProperty. More...

void	setHitTestable (bool value)
	Sets the value of HitTestableProperty. More...

bool	isHitTestableContainer () const
	Gets the value of HitTestableContainerProperty. More...

void	setHitTestableContainer (bool value)
	Sets the value of HitTestableContainerProperty. More...

bool	isVisible () const
	Gets the value of VisibleProperty. More...

void	setVisible (bool value)
	Sets the value of VisibleProperty. More...

bool	isEnabled () const
	Gets the value of EnabledProperty. More...

void	setEnabled (bool value)
	Sets the value of EnabledProperty. More...

bool	isFocusable () const
	Gets the value of FocusableProperty. More...

void	setFocusable (bool value)
	Sets the value of FocusableProperty. More...

bool	isFocused () const
	Gets the value of FocusedProperty. More...

void	setFocused (bool value)
	Sets the value of FocusedProperty. More...

bool	hasLogicalFocus () const
	Returns the #LogicalFocusedProperty value. More...

void	setLogicalFocus (bool value)
	Sets the value of LogicalFocusProperty. More...

FontSharedPtr	getFont () const
	Gets the value of FontProperty. More...

void	setFont (FontSharedPtr value)
	Sets the value of FontProperty. More...

float	getVisibleAmountInParent () const
	Gets the value of VisibleAmountInParentProperty. More...

void	setVisibleAmountInParent (float value)
	Sets the value of VisibleAmountInParentProperty. More...

float	getProjection2DTo3DScale () const
	Gets the value of Projection2DTo3DScaleProperty. More...

void	setProjection2DTo3DScale (float value)
	Sets the value of Projection2DTo3DScaleProperty. More...

bool	isEnableClick () const
	Gets the value of EnableClickProperty. More...

void	setEnableClick (bool value)
	Sets the value of EnableClickProperty. More...

bool	isEnableMultiClick () const
	Gets the value of EnableMultiClickProperty. More...

void	setEnableMultiClick (bool value)
	Sets the value of EnableMultiClickProperty. More...

ResourceSharedPtr	getStyle () const
	Gets the value of StyleProperty. More...

void	setStyle (ResourceSharedPtr value)
	Sets the value of StyleProperty. More...

ResourceSharedPtr	getStateManager () const
	Gets the value of StateManagerProperty. More...

void	setStateManager (ResourceSharedPtr value)
	Sets the value of StateManagerProperty. More...

float	getWidth () const
	Gets the value of WidthProperty. More...

void	setWidth (float value)
	Sets the value of WidthProperty. More...

float	getHeight () const
	Gets the value of HeightProperty. More...

void	setHeight (float value)
	Sets the value of HeightProperty. More...

float	getDepth () const
	Gets the value of DepthProperty. More...

void	setDepth (float value)
	Sets the value of DepthProperty. More...

float	getActualWidth () const
	Gets the value of ActualWidthProperty. More...

void	setActualWidth (float value)
	Sets the value of ActualWidthProperty. More...

float	getActualHeight () const
	Gets the value of ActualHeightProperty. More...

void	setActualHeight (float value)
	Sets the value of ActualHeightProperty. More...

float	getActualDepth () const
	Gets the value of ActualDepthProperty. More...

void	setActualDepth (float value)
	Sets the value of ActualDepthProperty. More...

Node::HorizontalAlignment	getHorizontalAlignment () const
	Gets the value of HorizontalAlignmentProperty. More...

void	setHorizontalAlignment (Node::HorizontalAlignment value)
	Sets the value of HorizontalAlignmentProperty. More...

Node::VerticalAlignment	getVerticalAlignment () const
	Gets the value of VerticalAlignmentProperty. More...

void	setVerticalAlignment (Node::VerticalAlignment value)
	Sets the value of VerticalAlignmentProperty. More...

Node::DepthAlignment	getDepthAlignment () const
	Gets the value of DepthAlignmentProperty. More...

void	setDepthAlignment (Node::DepthAlignment value)
	Sets the value of DepthAlignmentProperty. More...

Vector2	getHorizontalMargin () const
	Gets the value of HorizontalMarginProperty. More...

void	setHorizontalMargin (Vector2 value)
	Sets the value of HorizontalMarginProperty. More...

Vector2	getVerticalMargin () const
	Gets the value of VerticalMarginProperty. More...

void	setVerticalMargin (Vector2 value)
	Sets the value of VerticalMarginProperty. More...

Vector2	getDepthMargin () const
	Gets the value of DepthMarginProperty. More...

void	setDepthMargin (Vector2 value)
	Sets the value of DepthMarginProperty. More...

Node::ContentStretch	getContentStretch () const
	Gets the value of ContentStretchProperty. More...

void	setContentStretch (Node::ContentStretch value)
	Sets the value of ContentStretchProperty. More...

float	getOpacity () const
	Gets the value of OpacityProperty. More...

void	setOpacity (float value)
	Sets the value of OpacityProperty. More...

bool	isClipChildren () const
	Gets the value of ClipChildrenProperty. More...

void	setClipChildren (bool value)
	Sets the value of ClipChildrenProperty. More...

Public Member Functions inherited from kanzi::Object
	Object (Domain *domain)

virtual	~Object ()

Domain *	getDomain () const
	Returns the domain the object belongs to. More...

KzuTaskScheduler *	getTaskScheduler () const
	Returns the task scheduler of the object. More...

KzuMessageDispatcher *	getMessageDispatcher () const
	Returns the message dispatcher of the object. More...

ResourceManager *	getResourceManager () const
	Returns the resource manager of the object. More...

virtual const Metaclass *	getDynamicMetaclass () const KZ_OVERRIDE
	Returns the metaclass of the dynamic type of the object. More...

AppliedStyleEntrySharedPtr	applyObjectStyle (kanzi::StyleSharedPtr style)
	Applies a style to an object. More...

void	unapplyObjectStyle (AppliedStyleEntrySharedPtr appliedStyleEntry)

void	applyObjectStyles ()
	Apply all styles for an object node. More...

void	unapplyObjectStyles ()
	Unapplies and removes all applied styles. More...

Public Member Functions inherited from kanzi::MetaObject
virtual	~MetaObject ()

bool	isTypeOf (const Metaclass *objectType) const
	Determines if the type of this object is the given type or derived from it. More...

Public Member Functions inherited from kanzi::PropertyObject
	PropertyObject ()

virtual	~PropertyObject ()

template<typename DataType >
void	setProperty (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Traits::ParameterType value)
	Sets the local value of a property. More...

void	removeKzbProperties ()

template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getProperty (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property. More...

template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType >	getOptionalProperty (const PropertyType< DataType > &propertyType) const
	Evaluates the property value in the same way as the overload above but does not default to the value in property metadata if there are no inputs to the property value. More...

template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getPropertyBase (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property disregarding modifiers. More...

template<typename DataType >
void	setAbstractProperty (AbstractPropertyType abstractPropertyType, typename PropertyType< DataType >::Traits::ParameterType value)

template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getAbstractProperty (AbstractPropertyType abstractPropertyType) const

template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getAbstractPropertyBase (AbstractPropertyType abstractPropertyType) const

template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType >	getOptionalAbstractProperty (AbstractPropertyType abstractPropertyType) const

void	setPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)

bool	isPropertyFlagSet (AbstractPropertyType propertyType, uint32_t flag) const

void	clearPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)

bool	hasValue (AbstractPropertyType propertyType) const
	Evaluates whether there are any inputs into the property value. More...

bool	hasBaseValue (AbstractPropertyType propertyType) const
	Evaluates whether there are any inputs into the property value, disregarding modifiers. More...

bool	hasLocalValue (AbstractPropertyType propertyType) const
	Evaluates whether there is a local value set for the property. More...

bool	hasNonClassValue (AbstractPropertyType propertyType) const
	Evaluates whether there is a value of any precedence higher than class default value set for the property. More...

void	removeLocalValue (AbstractPropertyType propertyType)
	Removes the local value associated with the property. More...

void	copyLocalValue (const PropertyObject &other, AbstractPropertyType propertyType)
	Copies local value of single property from another object. More...

void	copyLocalValues (const PropertyObject &other)
	Copies all local values from another object. More...

template<typename DataType >
void	addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource valueSource, PropertyValuePrecedence precedence, void owner)

template<typename DataType >
void	removePropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource valueSource, void owner)

template<typename DataType >
void	addPropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)

template<typename DataType >
void	removePropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)

void	validatePropertyModifiers (AbstractPropertyType propertyType)

template<typename DataType >
void	addPropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)

template<typename DataType >
void	removePropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)

template<typename DataType >
size_t	getPropertyNotificationHandlerCount (const PropertyType< DataType > &propertyType)
	Gets number of current notification handlers for given property type. More...

Static Public Member Functions
static PageHostSharedPtr	create (Domain *domain, string_view name)
	Creates a PageHost node. More...

Static Public Member Functions inherited from kanzi::Page
static PageSharedPtr	create (Domain *domain, string_view name)
	Creates a Page node. More...

Static Public Member Functions inherited from kanzi::Node2D
static float	layoutUp ()

static bool	isValidLayoutSize (Vector2 size)
	Indicates whether a size is valid layout size. More...

static Vector2	unboundedLayoutSize ()
	Returns an unbounded layout size. More...

static bool	isUnboundedLayoutSize (Vector2 layoutSize)
	Indicates whether a layout size is an unbound layout size. More...

static Vector2	replaceUnboundedLayoutSize (Vector2 layoutSize, Vector2 resetSize)
	Replaces any element of a layout size with appropriate element of the reset size if it is unbounded and returns the size. More...

static Vector2	replaceUnboundedLayoutSizeWithZero (Vector2 layoutSize)
	Replaces any element of a layout size with zero if it is unbounded and returns the size. More...

static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()

Static Public Member Functions inherited from kanzi::Node
static bool	isValidLayoutValue (float value)
	Indicates whether a value is valid layout value. More...

static float	unboundedLayoutValue ()
	Returns an unbounded layout value. More...

static bool	isUnboundedLayoutValue (float layoutValue)
	Indicates whether a value is an unbound layout value. More...

static float	replaceUnboundedLayoutValue (float layoutValue, float resetValue)
	Replaces layout value with the specified value if it is unbounded and returns it. More...

static float	replaceUnboundedLayoutValueWithZero (float layoutValue)
	Replaces layout value with zero if it is unbounded layout value and returns it. More...

Static Public Member Functions inherited from kanzi::Object
static const Metaclass *	getStaticMetaclass ()
	Returns the metaclass of Object class. More...

static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()
	Default implementation that returns empty editor info. More...

Static Public Member Functions inherited from kanzi::MetaObject
static const Metaclass *	getStaticMetaclass ()
	Returns the metaclass of Object class. More...

static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()
	Default implementation that returns empty editor info. More...

Static Public Attributes
static MessageType< NavigationStartedMessageArguments >	NavigationStartedMessage
	Navigation started message type. More...

static MessageType< NavigationFinishedMessageArguments >	NavigationFinishedMessage
	Navigation finished message type. More...

static MessageType< NavigateNextMessageArguments >	NavigateNextMessage
	NavigateNext message type. More...

static MessageType< NavigatePreviousMessageArguments >	NavigatePreviousMessage
	NavigatePrevious message type. More...

Static Public Attributes inherited from kanzi::Page
static MessageType< NavigateMessageArguments >	NavigateMessage
	Navigate message type. More...

static MessageType< NavigateParentMessageArguments >	NavigateParentMessage
	NavigateParent message type. More...

static MessageType< ActivatedMessageArguments >	ActivatedMessage
	Activated message type. More...

static MessageType< DeactivatedMessageArguments >	DeactivatedMessage
	Deactivated message type. More...

static PropertyType< bool >	StateProperty
	State property. More...

static PropertyType< float >	TransitionPhaseProperty
	TransitionPhase property. More...

static PropertyType< bool >	AutoActivateProperty
	AutoActivate property. More...

static PropertyType< Vector2 >	SlideOffsetProperty
	SlideOffset property. More...

static PropertyType< Vector2 >	ScaleOffsetProperty
	ScaleOffset property. More...

static PropertyType< float >	RotationOffsetProperty
	RotationOffset property. More...

Static Public Attributes inherited from kanzi::Node2D
static PropertyType< float >	AspectRatioProperty
	AspectRatio property. More...

static PropertyType< bool >	ForceCompositionProperty
	ForceComposition property. More...

static PropertyType< Node2D::ForegroundHint >	ForegroundHintProperty
	ForegroundHint property. More...

static PropertyType< bool >	CacheChildrenProperty
	CacheChildren property. More...

static PropertyType< bool >	CacheResultProperty
	CacheResult property. More...

static PropertyType< bool >	CacheSelfProperty
	CacheSelf property. More...

static PropertyType< bool >	OffscreenRenderingProperty
	OffscreenRendering property. More...

static PropertyType< bool >	DisableRenderTargetClearProperty
	DisableRenderTargetClear property. More...

static PropertyType< Node2D::PixelFormat >	PixelFormatProperty
	PixelFormat property. More...

static PropertyType< bool >	RenderSelfProperty
	RenderSelf property. More...

static PropertyType< ResourceSharedPtr >	RenderTargetProperty
	RenderTarget property. More...

static PropertyType< float >	RenderTargetMinimumHeightProperty
	RenderTargetMinimumHeight property. More...

static PropertyType< float >	RenderTargetMinimumWidthProperty
	RenderTargetMinimumWidth property. More...

static PropertyType< float >	RenderTargetReallocationLimitProperty
	RenderTargetReallocationLimit property. More...

static PropertyType< SRTValue2D >	LayoutTransformationProperty
	LayoutTransformation property. More...

static PropertyType< SRTValue2D >	RenderTransformationProperty
	RenderTransformation property. More...

static PropertyType< SRTValue3D >	PerspectiveTransformationProperty
	PerspectiveTransformation property. More...

static PropertyType< Vector2 >	RenderTransformationOriginProperty
	RenderTransformationOrigin property. More...

static PropertyType< bool >	SnapToPixelProperty
	SnapToPixel property. More...

static PropertyType< ResourceSharedPtr >	BackgroundBrushProperty
	BackgroundBrush property. More...

static PropertyType< ResourceSharedPtr >	CompositionBrushProperty
	CompositionBrush property. More...

static PropertyType< ResourceSharedPtr >	ForegroundBrushProperty
	ForegroundBrush property. More...

Static Public Attributes inherited from kanzi::Node
static PropertyType< string >	NameProperty
	Name property. More...

static PropertyType< string >	PathProperty
	Path property. More...

static PropertyType< string >	LocaleProperty
	Locale property. More...

static PropertyType< bool >	CreatedFromKZBProperty
	CreatedFromKZB property. More...

static PropertyType< bool >	HitTestableProperty
	HitTestable property. More...

static PropertyType< bool >	HitTestableContainerProperty
	HitTestableContainer property. More...

static PropertyType< bool >	VisibleProperty
	Visible property. More...

static PropertyType< bool >	EnabledProperty
	Enabled property. More...

static PropertyType< bool >	FocusableProperty
	The property specifies whether a node can get active focus and can participate in the focus chain navigation. More...

static PropertyType< bool >	FocusedProperty
	Specifies that the node is the active focus node, which receives keyboard messages. More...

static PropertyType< bool >	LogicalFocusProperty
	Specifies that the node has logical focus state. More...

static PropertyType< ResourceSharedPtr >	FontProperty
	Font property. More...

static PropertyType< float >	VisibleAmountInParentProperty
	VisibleAmountInParent property. More...

static PropertyType< float >	Projection2DTo3DScaleProperty
	Projection2DTo3DScale property. More...

static PropertyType< bool >	EnableClickProperty
	EnableClick property. More...

static PropertyType< bool >	EnableMultiClickProperty
	EnableMultiClick property. More...

static PropertyType< ResourceSharedPtr >	StyleProperty
	Style property. More...

static PropertyType< ResourceSharedPtr >	StateManagerProperty
	StateManager property. More...

static PropertyType< void * >	PrefabTemplateSourceProperty
	PrefabTemplateSource property. More...

static PropertyType< float >	WidthProperty
	Width property. More...

static PropertyType< float >	HeightProperty
	Height property. More...

static PropertyType< float >	DepthProperty
	Depth property. More...

static PropertyType< float >	ActualWidthProperty
	ActualWidth property. More...

static PropertyType< float >	ActualHeightProperty
	ActualHeight property. More...

static PropertyType< float >	ActualDepthProperty
	ActualDepth property. More...

static PropertyType< Node::HorizontalAlignment >	HorizontalAlignmentProperty
	HorizontalAlignment property. More...

static PropertyType< Node::VerticalAlignment >	VerticalAlignmentProperty
	VerticalAlignment property. More...

static PropertyType< Node::DepthAlignment >	DepthAlignmentProperty
	DepthAlignment property. More...

static PropertyType< Vector2 >	HorizontalMarginProperty
	HorizontalMargin property. More...

static PropertyType< Vector2 >	VerticalMarginProperty
	VerticalMargin property. More...

static PropertyType< Vector2 >	DepthMarginProperty
	DepthMargin property. More...

static PropertyType< Node::ContentStretch >	ContentStretchProperty
	ContentStretch property. More...

static PropertyType< float >	OpacityProperty
	Opacity property. More...

static PropertyType< bool >	ClipChildrenProperty
	ClipChildren property. More...

static PropertyType< int >	SceneGraphAddNodeChangeChildFlagsProperty
	SceneGraphAddNodeChangeChildFlags property. More...

static PropertyType< int >	SceneGraphAddNodeChangeParentFlagsProperty
	SceneGraphAddNodeChangeParentFlags property. More...

static PropertyType< int >	SceneGraphRemoveNodeChangeChildFlagsProperty
	SceneGraphRemoveNodeChangeChildFlags property. More...

static PropertyType< int >	SceneGraphRemoveNodeChangeParentFlagsProperty
	SceneGraphRemoveNodeChangeParentFlags property. More...

Protected Member Functions
	PageHost (Domain *domain, string_view name)
	Constructor. More...

virtual void	onAttached () KZ_OVERRIDE
	onAttached() implementation. More...

virtual void	onDetached () KZ_OVERRIDE
	onDetached() implementation. More...

void	initialize ()

virtual void	onNodePropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason) KZ_OVERRIDE
	Node::onPropertyChanged implementation. More...

Protected Member Functions inherited from kanzi::Page
	Page (Domain *domain, string_view name)
	Constructor. More...

virtual void	arrangeOverride (Vector2 actualSize) KZ_OVERRIDE
	Node2D::arrangeOverride() implementation. More...

void	initialize ()
	Initializes this page. More...

Protected Member Functions inherited from kanzi::Node2D
	Node2D (Domain *domain, string_view name)
	Constructor. More...

void	initialize ()

NodeVisual2D &	acquireVisual ()
	Initializes and returns visual structure. More...

virtual void	renderOverride (Renderer3D &renderer, CompositionStack &compositionStack)
	Node-specific top-level render call. More...

void	renderRecursive (Renderer3D &renderer, CompositionStack &compositionStack, const Matrix3x3 &baseTransform)
	Render a Node2D and then recursively all its children. More...

virtual void	renderSelfOverride (Renderer3D &renderer, CompositionStack &compositionStack, const Matrix3x3 &baseTransform)
	Node-specific rendering. More...

void	renderChildren (Renderer3D &renderer, CompositionStack &compositionStack, const Matrix3x3 &baseTransform)
	Render all children of a Node2D. More...

void	renderBackground (Renderer3D &renderer, const CompositionStack &compositionStack, const Matrix3x3 &baseTransform)
	Render background quad of a Node2D. More...

void	renderForeground (Renderer3D &renderer, CompositionStack &compositionStack, const Matrix3x3 &baseTransform)
	Render foreground of a Node2D. More...

virtual void	renderForegroundOverride (Renderer3D &renderer, CompositionStack &compositionStack, const Matrix3x3 &baseTransform)
	Node-specific foreground render. More...

bool	pushLocalViewportArea (CompositionStack &compositionStack)
	Push local viewport and scissor area into composition stack if it's required. More...

NodeCompositor2D &	acquireCompositor ()
	Initializes and returns composition structure. More...

void	clearCompositionTarget (Renderer3D &renderer, CompositionStack &compositionStack, bool clearColor)
	Clear node render target. More...

virtual Vector2	measureOverride (Vector2 availableSize)
	Default implementation of Node2D size calculation. More...

virtual void	arrangeRecursive (const Matrix3x3 &worldTransform, const Matrix3x3 &parentTransform, bool arrangeNeeded, bool transformChanged)
	Perform arrange recursively. More...

optional< float >	getUserAspectRatio () const
	Get aspect ratio property assigned to the node. More...

optional< float >	getUserHeight () const
	Get layout height property assigned to the node. More...

optional< float >	getUserWidth () const
	Get layout width property assigned to the node. More...

Vector2	getDesiredSizeAxisAlignedBoundingBoxMinimum () const
	Get desired size axis aligned bounding box minimum. More...

void	setDesiredSizeAxisAlignedBoundingBoxMinimum (Vector2 size)
	Set desired size axis aligned bounding box minimum. More...

void	setDesiredSizeAxisAlignedBoundingBoxMinimum (float sizeX, float sizeY)
	Set desired size axis aligned bounding box minimum. More...

Vector2	getDesiredSizeAxisAlignedBoundingBoxMaximum () const
	Get desired size axis aligned bounding box maximum. More...

void	setDesiredSizeAxisAlignedBoundingBoxMaximum (Vector2 size)
	Set desired size axis aligned bounding box maximum. More...

void	setDesiredSizeAxisAlignedBoundingBoxMaximum (float sizeX, float sizeY)
	Set desired size maximum. More...

void	calculateTransformedBoundingArea (const Matrix3x3 &transform, Vector2 sizeIn)
	Calculate new transformed bounding area. More...

Matrix3x3	updateFinalTransform (const Matrix3x3 &worldTransform, const Matrix3x3 &parentTransform)
	Update final transformation. More...

bool	updateRender (const Matrix3x3 &worldTransform, const Matrix3x3 &parentTransform, bool transformChanged)
	Validate node for rendering. More...

virtual void	updateRenderOverride ()
	Node-specific updates done before render. More...

optional< QuadDescription >	calculateContentStretch (Vector2 renderSize, Vector2 contentSize)
	Calculate content stretch. More...

ClippingArea	calculateClippingArea (const Matrix3x3 &parentSpaceTransform) const
	Calculate clipping parameters. More...

unsigned int	performClipping (QuadDescription &backgroundQuad, optional< QuadDescription > &foregroundQuad, unsigned int clippingResult)
	Perform rectangle clipping. More...

void	extractChildren () const
	Extract children of node, called from extraction implementations. More...

virtual void	onExtract ()
	Node2D extract function. More...

virtual void	restoreResources () KZ_OVERRIDE
	Node::restoreResources() implementation. More...

bool	isCompletelyClipped () const
	Tell if node is completely clipped (and needs not be rendered). More...

bool	isCompletelyTransparent () const
	Tell if node is completely transparent. More...

bool	isEmptyActualSize () const
	Tell if the size of the node is empty or invalid. More...

bool	isForegroundHintOpaque () const
	Tell if foreground hint is opaque. More...

bool	isForegroundHintTranslucent () const
	Tell if foreground hint is translucent. More...

bool	isForegroundTranslucencyRequested () const
	Tell if foreground translucency has been requested. More...

void	setForegroundTranslucencyRequested (bool enabled)
	Turn foreground translucency request on or off. More...

void	setPartialArrangeTransform (Matrix3x3 transform)
	Sets partial arrange transform. More...

void	setRenderChildrenAllowed (bool enabled)
	Turn render children on or off. More...

void	setRenderSelfAllowed (bool enabled)
	Turn render self on or off. More...

void	setRenderType (RenderType renderType)
	Set render type. More...

void	updateContentTexture (TextureSharedPtr texture)
	Update content texture for the foreground brush. More...

void	setSecondPassDesiredSize (Vector2 size)
	Set second pass desired size. More...

Protected Member Functions inherited from kanzi::Node
	Node (Domain *domain, string_view name)
	Constructor. More...

void	initialize ()

void	updatePropertiesForConnectedNode ()
	Invokes property notifications for inherited properties during scene graph tree connections. More...

void	updatePropertiesForDisconnectedNode (Node *oldParent)
	Invokes property notifications for inherited properties during scene graph tree disconnections. More...

void	updateResourceReferences ()

void	updateResourceReferences (AbstractPropertyType propertyType)

void	updateResourceReferencesRecursive ()

void	updateResourceReferencesRecursive (const ResourceID &resourceID)

void	attach ()
	Attaches the object node. More...

void	detach ()
	Detaches the object node. More...

virtual void	notifyPropertyHandlers (PropertyStoragePtr &propertyStorage, PropertyNotificationReason reason) KZ_OVERRIDE

Protected Member Functions inherited from kanzi::Object
void	initialize ()

void	onCopy (const Object &other)

Protected Member Functions inherited from kanzi::MetaObject
	MetaObject ()

void	initialize ()

Protected Member Functions inherited from kanzi::PropertyObject
void	addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource valueSource, PropertyValuePrecedence precedence, void owner)

void	removePropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource valueSource, void owner)

AbstractPropertyTypeDescriptor::ValueSourceEntry *	getTopValueSourceEntry (AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage) const

AbstractPropertyTypeDescriptor::ValueSourceEntry *	getTopValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::ValueSource *	getTopValueSource (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::ValueSource *	getFinalValueSource (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::ValueSource *	getNonClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::ValueSource *	getClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::ValueSourceEntry *	findLocalValueSourceEntry (AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)

AbstractPropertyTypeDescriptor::ValueSourceEntry *	constructLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)

AbstractPropertyTypeDescriptor::ValueSourceEntry *	acquireLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor)

AbstractPropertyTypeDescriptor::PropertyStorage *	findPropertyStorage (AbstractPropertyTypeDescriptor &descriptor) const

PropertyStoragePtr	findPropertyStoragePtr (AbstractPropertyTypeDescriptor &descriptor) const
	Gets property storage intrusive pointer that can be used to hold a reference until end of operation. More...

PropertyStoragePtr	constructPropertyStorage (AbstractPropertyTypeDescriptor &descriptor)

PropertyStoragePtr	acquirePropertyStorage (AbstractPropertyTypeDescriptor &descriptor)

AbstractPropertyTypeDescriptor::ModifierStorage *	acquireModifierStorage (AbstractPropertyTypeDescriptor &descriptor)

AbstractPropertyTypeDescriptor::ModifierStorage *	findModifierStorage (AbstractPropertyTypeDescriptor &descriptor)

AbstractPropertyTypeDescriptor::NotificationStorage *	acquireNotificationStorage (AbstractPropertyTypeDescriptor &descriptor)

AbstractPropertyTypeDescriptor::NotificationStorage *	findNotificationStorage (AbstractPropertyTypeDescriptor &descriptor)

AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByUnqualifiedNameAndDataType (string_view unqualifiedName, PropertyDataType dataType)

void	validatePropertyModifiersAndNotifyHandlers (PropertyStoragePtr &propertyStorage)

void	copyLocalValue (const AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
	Copy local value from property storage. More...

PropertyStorageContainer::iterator	beginPropertyStorage ()

PropertyStorageContainer::iterator	endPropertyStorage ()

void	onCopy (const PropertyObject &other)

Properties
static PropertyType< ResourceSharedPtr >	TransitionsProperty
	Transitions property. More...

static PropertyType< string >	DefaultSubPageProperty
	DefaultSubPage property. More...

static PropertyType< bool >	LoopSubPagesProperty
	LoopSubPages property. More...

ResourceSharedPtr	getTransitions () const
	Gets the value of TransitionsProperty. More...

void	setTransitions (ResourceSharedPtr value)
	Sets the value of TransitionsProperty. More...

string	getDefaultSubPage () const
	Gets the value of DefaultSubPageProperty. More...

void	setDefaultSubPage (string value)
	Sets the value of DefaultSubPageProperty. More...

bool	isLoopSubPages () const
	Gets the value of LoopSubPagesProperty. More...

void	setLoopSubPages (bool value)
	Sets the value of LoopSubPagesProperty. More...

Additional Inherited Members
Public Types inherited from kanzi::Node2D
enum	PixelFormat { PixelFormatRgb, PixelFormatRgba }

enum	ForegroundHint { ForegroundHintNone, ForegroundHintTranslucent, ForegroundHintOpaque }
	Hint for foreground handling of nodes. More...

enum	RenderType { RenderTypeNone, RenderTypeTexture, RenderTypeManual, RenderTypeManualClipped }
	Node2D render type - affects elementary decisions about node rendering. More...

typedef Vector2	LayoutVectorType

typedef Matrix3x3	LayoutMatrixType

typedef vector< Node2DSharedPtr >	ChildContainer
	Container type for children. More...

typedef ChildContainer::const_iterator	ChildConstIterator
	Iterator type for children. More...

typedef ChildContainer::const_reverse_iterator	ChildConstReverseIterator
	Reverse iterator type for children. More...

typedef NodeSharedPtr(*	HitTestVisitor) (Node2D &node, Vector2 nodePoint, void *userData)
	Hit test visitor function. More...

Public Types inherited from kanzi::Node
enum	HorizontalAlignment { HorizontalAlignmentLeft, HorizontalAlignmentRight, HorizontalAlignmentCenter, HorizontalAlignmentStretch }
	Horizontal alignment options. More...

enum	VerticalAlignment { VerticalAlignmentBottom, VerticalAlignmentTop, VerticalAlignmentCenter, VerticalAlignmentStretch }
	Vertical alignment options. More...

enum	DepthAlignment { DepthAlignmentBack, DepthAlignmentFront, DepthAlignmentCenter, DepthAlignmentStretch }
	Depth alignment options. More...

enum	ContentStretch { ContentStretchNone, ContentStretchFill, ContentStretchUniform, ContentStretchUniformToFill, ContentStretchRepeat }
	Content stretch option. More...

enum	VisitorOrder { VisitorPreOrder, VisitorPostOrder }

enum	VisitorResult { VisitorAbort, VisitorContinue, VisitorContinueSibling }

typedef kanzi::vector< Node::MessageSubscriptionToken >	MessageSubscriptionTokenVector

typedef function< VisitorResult(Node &)>	Visitor

typedef vector< InputManipulatorSharedPtr >	InputManipulatorContainer
	Gets the input manipulator iterator. More...

typedef InputManipulatorContainer::iterator	InputManipulatorIterator

typedef InputManipulatorContainer::const_iterator	InputManipulatorConstIterator

typedef vector< BindingEntry >	BindingContainer
	Gets the bindings iterator. More...

typedef BindingContainer::iterator	BindingIterator

typedef BindingContainer::const_iterator	BindingConstIterator

typedef vector< NodeComponentEntry >	NodeComponentContainer
	Gets the node component iterator. More...

typedef NodeComponentContainer::iterator	NodeComponentIterator

typedef NodeComponentContainer::const_iterator	NodeComponentConstIterator

Public Types inherited from kanzi::PropertyObject
typedef intrusive_ptr< AbstractPropertyTypeDescriptor::PropertyStorage >	PropertyStoragePtr

typedef vector< PropertyStoragePtr >	PropertyStorageContainer

typedef PropertyStorageContainer::iterator	PropertyStorageIterator

typedef PropertyStorageContainer::const_iterator	PropertyStorageConstIterator

typedef PropertyStorageContainer::reverse_iterator	PropertyStorageReverseIterator

Protected Types inherited from kanzi::Node2D
enum	Node2DFlags { AllowClear, AllowRenderChildren, AllowRenderSelf, ForegroundIsTranslucent, ForegroundTranslucencyRequested, RequiresBackgroundQuad, RequiresExtract, ChildrenRequireExtract, Node2DFlagsBitCount }
	Different Node2D flags for bit set. More...

Protected Types inherited from kanzi::Object
typedef vector< AppliedStyleEntrySharedPtr >	AppliedStyleContainer
	Applied style container. More...

Static Protected Member Functions inherited from kanzi::Node
static VisitorResult	updateResourceVisitor (Node &node, const ResourceID &id)

static VisitorResult	updateAllResourcesVisitor (Node &node)

static VisitorResult	applyStylesVisitor (Node &node, bool apply)

static VisitorResult	attachVisitor (Node &node)

static VisitorResult	detachVisitor (Node &node)

static VisitorResult	validateDrawVisitor (Node &node)
	Visitor for validating draw. More...

static bool	processPropertyChanged (Node &node, AbstractPropertyType propertyType, const PropertyStoragePtr &nodePropertyStorage, AbstractPropertyTypeDescriptor::PropertyStorage *changedPropertyStorage, PropertyNotificationReason reason)
	Processes notification handlers for node and property storage. More...

static VisitorResult	propertyChangedVisitor (Node &node, AbstractPropertyType propertyType, AbstractPropertyTypeDescriptor::PropertyStorage *propertyStorage, PropertyNotificationReason reason)

Protected Attributes inherited from kanzi::Node2D
unique_ptr< NodeVisual2D >	m_visual
	Visual information. More...

unique_ptr< NodeCompositor2D >	m_compositor
	Composition and caching information. More...

QuadDescription	m_backgroundQuadDescription
	Background clipping quad / composition quad description. More...

ClippingArea	m_clipping
	Clipping parameters. More...

CompositionRequirements	m_compositionRequirements
	Composition requirements for this 2D node. More...

Protected Attributes inherited from kanzi::Object
AppliedStyleContainer	m_appliedStyles
	Listing of applied styles applied to this object. More...

Static Protected Attributes inherited from kanzi::Page
static MessageType< NavigationActivatedMessageArguments >	NavigationActivatedMessage
	NavigationActivated message type. Used internally by the navigation system. More...

static MessageType< NavigationDeactivatedMessageArguments >	NavigationDeactivatedMessage
	NavigationDeactivated message type. Used internally by the navigation system. More...

static MessageType< RegisterToNavigationMessageArguments >	RegisterToNavigationMessage
	RegisterToNavigation message type. Used internally by the navigation system. More...

static MessageType< UnregisterFromNavigationMessageArguments >	UnregisterFromNavigationMessage
	UnregisterFromNavigation message type. Used internally by the navigation system. More...

Detailed Description

Use a PageHost node to group Page and PageHost nodes, and to manage navigation requests and transitions in a tree of Page nodes under a PageHost node.

The role of PageHost nodes in navigation

When you set a PageHost node as an ancestor of a Page node, that PageHost node listens for navigation requests from its descendant Page nodes. When a PageHost node receives a navigation request, it starts the navigation process to the Page node which dispatched the message. The navigation process involves resolving the route from the currently active Page or PageHost node to the target Page or PageHost node, and then performing transitions between Page nodes in the navigation route until the target Page or PageHost node is activated. Each PageHost node manages the navigation within its own scope and does not interfere with other PageHost nodes.

Activation tracking

PageHost nodes keep track of the currently active Page or PageHost node within their scope. When you activate a PageHost node, that PageHost node automatically activates the currently active Page or PageHost node in its scope. This allows the PageHost node to remember and restore its state during activation to the state before it was deactivated.

Navigating between subpages

PageHost nodes contain the functionality to navigate between the next and previous Page and PageHost nodes within their scope. This allows you to build support for navigation using key input. You can further configure this functionality to set whether you want a PageHost node to loop from the last to the first or the first to the last Page node when navigating to the next and the previous Page and PageHost.

Nesting PageHost nodes

You can nest PageHost nodes to create the structure of an application user interface. For example, you can have one PageHost node managing the root-level navigation in the application user interface, such as transitions between the Home, Media Browser, Navigation, and Settings, and add to it child PageHost nodes, each of which manages its own hierarchy of Page nodes, such as Media Browser's own Page nodes.

See also: Page

Examples

To transition to the selected Page node:

        // Look up child page in the scope of Page host.
        PageSharedPtr subPage = host->lookupNode<Page>(path);
        // Request animated transition to given page.
        subPage->navigate();

To transition instantly to the selected Page node:

// Make immediate transition, without playing an animation.

subPage->navigate(true);

To get the currently active Page or PageHost descendant node:

// Retrieve currently active subpage.

PageSharedPtr currentSubPage = host->getDefaultChild();

To transition from the current subpage to the next subpage:

        // Request animated transition from currently active page to next subpage.
        PageHost::NavigateNextMessageArguments args;
        host->dispatchMessage(PageHost::NavigateNextMessage, args);

Constructor & Destructor Documentation

kanzi::PageHost::PageHost	(	Domain *	domain,
		string_view	name
	)

explicitprotected

Constructor.

Parameters

domain	The UI domain the new node belongs to.
name	The name of the node.

Member Function Documentation

static PageHostSharedPtr kanzi::PageHost::create	(	Domain *	domain,
		string_view	name
	)

static

Creates a PageHost node.

Parameters

domain	The UI domain the new node belongs to.
name	The name of the node.

Returns: The created node.

ResourceSharedPtr kanzi::PageHost::getTransitions ( ) const

inline

Gets the value of TransitionsProperty.

See also: setTransitions()

void kanzi::PageHost::setTransitions ( ResourceSharedPtr value )

inline

Sets the value of TransitionsProperty.

See also: getTransitions()

string kanzi::PageHost::getDefaultSubPage ( ) const

inline

Gets the value of DefaultSubPageProperty.

See also: setDefaultSubPage()

void kanzi::PageHost::setDefaultSubPage ( string value )

inline

Sets the value of DefaultSubPageProperty.

See also: getDefaultSubPage()

bool kanzi::PageHost::isLoopSubPages ( ) const

inline

Gets the value of LoopSubPagesProperty.

See also: setLoopSubPages()

void kanzi::PageHost::setLoopSubPages ( bool value )

inline

Sets the value of LoopSubPagesProperty.

See also: isLoopSubPages()

PageSharedPtr kanzi::PageHost::getDefaultChild ( ) const

PageHost nodes keep track of their default or the currently active subpage.

This function returns the currently active subpage.

Returns: Shared pointer to the currently active subpage. If none of the PageHost child nodes are active, the return value is an empty pointer.

void kanzi::PageHost::setDefaultChild ( PageSharedPtr page )

Sets the default or the currently active subpage.

Kanzi automatically activates the default subpage when this PageHost is activated.

Parameters

page	Page to activate.

bool kanzi::PageHost::navigateTo	(	Page &	page,
		bool	immediate
	)

Requests to navigate to the given Page node.

Parameters

page	The Page node to which you want to navigate.
immediate	If true, the transition is instant.

Returns: Returns true if the navigation request is successful.

bool kanzi::PageHost::isTransitionInProgress ( ) const

Checks whether there is an ongoing transition between Page nodes.

Returns: Returns true if there is an ongoing transition, otherwise returns false.

PageTransitionCollectionSharedPtr kanzi::PageHost::getTransitionCollection ( ) const

Retrieves transitions used in the scope of this PageHost node.

Returns: Pointer to the page transition collection.

void kanzi::PageHost::setTransitionCollection ( PageTransitionCollectionSharedPtr transitions )

Set transitions to be used by this PageHost node.

When transitioning between pages, the PageHost determines the most suitable transition from the given collection and uses it to transition pages in and out.

Parameters

transitions Transition group to use for transitions in the scope of this PageHost node.

virtual void kanzi::PageHost::onAttached ( )

protectedvirtual

onAttached() implementation.

Reimplemented from kanzi::Page.

virtual void kanzi::PageHost::onDetached ( )

protectedvirtual

onDetached() implementation.

Reimplemented from kanzi::Page.

void kanzi::PageHost::initialize ( )

protected

virtual void kanzi::PageHost::onNodePropertyChanged	(	AbstractPropertyType	propertyType,
		PropertyNotificationReason	reason
	)

protectedvirtual

Node::onPropertyChanged implementation.

Reimplemented from kanzi::Node2D.

Member Data Documentation

MessageType<NavigationStartedMessageArguments> kanzi::PageHost::NavigationStartedMessage

static

Navigation started message type.

Use this notification message to find out that the navigation process is about to start. Kanzi always dispatches this message before any navigation progress messages like, for example, Page.ActivatedMessage or Page.DeactivatedMessage.

MessageType<NavigationFinishedMessageArguments> kanzi::PageHost::NavigationFinishedMessage

static

Navigation finished message type.

Use this notification message to find out that the navigation process is about to end. Kanzi always dispatches this message after navigation progress messages like, for example, Page.ActivatedMessage or Page.DeactivatedMessage.

MessageType<NavigateNextMessageArguments> kanzi::PageHost::NavigateNextMessage

static

NavigateNext message type.

Use this message to tell a PageHost node to navigate from the currently active subpage to the next subpage.

MessageType<NavigatePreviousMessageArguments> kanzi::PageHost::NavigatePreviousMessage

static

NavigatePrevious message type.

Use this message to tell a PageHost node to navigate from the currently active subpage to the previous subpage.

PropertyType<ResourceSharedPtr> kanzi::PageHost::TransitionsProperty

static

Transitions property.

Transitions to be used within this PageHost node. The default value is ResourceSharedPtr().

See also: setTransitions(), getTransitions()

PropertyType<string> kanzi::PageHost::DefaultSubPageProperty

static

DefaultSubPage property.

The default or the currently active subpage, which Kanzi automatically activates whenever this PageHost node becomes active. The default value is "".

See also: setDefaultSubPage(), getDefaultSubPage()

PropertyType<bool> kanzi::PageHost::LoopSubPagesProperty

static

LoopSubPages property.

Loop the subpages when navigating to the next or previous subpage. The default value is true.

See also: setLoopSubPages(), isLoopSubPages()

The documentation for this class was generated from the following file:

kanzi/ui/node/page_host.hpp

Classes

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Properties

Additional Inherited Members

Detailed Description

The role of PageHost nodes in navigation

Activation tracking

Navigating between subpages

Nesting PageHost nodes

Examples

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation